Call detail fields
The call details endpoints return the fields below. A field marked as undefined in some circumstance is absent from the response entirely, rather than empty.
Identifiers
Live Hub returns these identifiers with a call detail.
| Field | Description |
|---|---|
callId
|
UUID of the call. |
botConversationId
|
Conversation ID, when the call is with a bot. Undefined otherwise. |
globalSessionId
|
Global Session ID (GID). |
expireTime
|
When the call detail is expected to be deleted. Present only once the record has been marked for deletion. |
Calling and called entities
The two ends of a call are reported as a calling entity and a called entity, each with its own group of fields. A call created by a transfer also reports the entity that referred it.
| Field | Description |
|---|---|
callingEntity.id
|
ID of the calling entity. |
callingEntity.type
|
Type of calling entity: bot, phone-number (a service number), or sip-connection. |
callingEntity.displayName
|
Name of the calling entity. |
callingEntity.phoneNumber
|
Phone number of the calling entity, which may have gone through number manipulation, to E.164 for example. Applies only to an AudioCodes service number. |
callingEntity.customizedInfo
|
A user-defined string for the ingress (calling) side of the call, set through SBC message manipulation rules and returned URL-encoded. Undefined otherwise. |
calledEntity.id
|
ID of the called entity. |
calledEntity.type
|
Type of called entity: bot, phone-number, or sip-connection. |
calledEntity.displayName
|
Name of the called entity. |
calledEntity.phoneNumber
|
For an AudioCodes service number, the phone number, taken from the SDR field dest.serviceNumber. Undefined otherwise. |
calledEntity.serviceNumber
|
Service number. Applies only to a SIP connection with a configured or customized service number. Undefined otherwise. |
calledEntity.customizedInfo
|
A user-defined string for the egress (called) side of the call, set through SBC message manipulation rules and returned URL-encoded. Undefined otherwise. |
referredByEntity.type
|
For a call triggered by a transfer, the entity that referred it: bot or sip-connection. |
ingressCallingNumber
|
Number in the SIP From header of the INVITE. |
Timing
All three timestamps are RFC 3339 UTC, with a Z suffix.
| Field | Description |
|---|---|
setupTime
|
When the call was set up — the SIP INVITE. |
connectTime
|
When the call connected — the SIP 200 OK. |
endTime
|
When the call ended — a SIP BYE, or a failure. |
durationSeconds
|
Duration of the call, in seconds. |
Outcome
These fields report whether the call succeeded, why it was terminated, whether a transfer created it, and whether it was recorded.
| Field | Description |
|---|---|
successful
|
true if the call ended successfully, and false if it ended on a failure or never connected at all. |
terminationDescription
|
Reason the call was terminated. |
trigger
|
transfer if the call was created by a transfer. Undefined otherwise. |
recorded
|
true if the call, or part of it, was recorded, in which case you can fetch the audio through Recordings. false if it was not. |
Performance
One field, statistics, reports how quickly the bot and the speech services responded.
| Field | Description |
|---|---|
statistics
|
Delay metrics for the bot interaction, used to judge how responsive the system was. Each of speech-to-text (sttAvgDelayMs, sttMaxDelayMs, sttMedDelayMs), text-to-speech (ttsAvgDelayMs, ttsMaxDelayMs, ttsMedDelayMs), and bot processing (botAvgDelayMs, botMaxDelayMs, botMedDelayMs) is reported as an average, a maximum, and a median, in milliseconds. |